QuickTime 4 API Documentation

3D Graphics Programming with QuickDraw 3D 1.5.4

Previous | QD3D Book | Overview | Chapter Contents | Next |

Managing Aspect Ratio Cameras

QuickDraw 3D provides routines that you can use to create and edit aspect ratio cameras.

Q3ViewAngleAspectCamera_New

You can use the Q3ViewAngleAspectCamera_New function to create a new aspect ratio camera.

TQ3CameraObject Q3ViewAngleAspectCamera_New (
                     const TQ3ViewAngleAspectCameraData *cameraData);
cameraData
A pointer to an aspect ratio camera data structure.

DESCRIPTION

The Q3ViewAngleAspectCamera_New function returns, as its function result, a new aspect ratio camera having the camera characteristics specified by the cameraData parameter.

Q3ViewAngleAspectCamera_GetData

You can use the Q3ViewAngleAspectCamera_GetData function to get the data that defines an aspect ratio camera.

TQ3Status Q3ViewAngleAspectCamera_GetData (
                     TQ3CameraObject camera,
                     TQ3ViewAngleAspectCameraData *cameraData);
camera
An aspect ratio camera object.
cameraData
On exit, a pointer to an aspect ratio camera data structure.

DESCRIPTION

The Q3ViewAngleAspectCamera_GetData function returns, through the cameraData parameter, information about the aspect ratio camera specified by the camera parameter. See "Aspect Ratio Camera Data Structure" for a description of an aspect ratio camera data structure.

Q3ViewAngleAspectCamera_SetData

You can use the Q3ViewAngleAspectCamera_SetData function to set the data that defines an aspect ratio camera.

TQ3Status Q3ViewAngleAspectCamera_SetData (
                     TQ3CameraObject camera,
                     const TQ3ViewAngleAspectCameraData *cameraData);
camera
An aspect ratio camera object.
cameraData
A pointer to an aspect ratio camera data structure.

DESCRIPTION

The Q3ViewAngleAspectCamera_SetData function sets the data associated with the aspect ratio camera specified by the camera parameter to the data specified by the cameraData parameter.

Q3ViewAngleAspectCamera_GetFOV

You can use the Q3ViewAngleAspectCamera_GetFOV function to get the maximum field of view of an aspect ratio camera.

TQ3Status Q3ViewAngleAspectCamera_GetFOV (
                     TQ3CameraObject camera,
                     float *fov);
camera
An aspect ratio camera object.
fov
On exit, the maximum field of view, in radians, of the specified camera.

DESCRIPTION

The Q3ViewAngleAspectCamera_GetFOV function returns, in the fov parameter, the maximum field of view of the aspect ratio camera specified by the camera parameter.

Q3ViewAngleAspectCamera_SetFOV

You can use the Q3ViewAngleAspectCamera_SetFOV function to set the maximum field of view of an aspect ratio camera.

TQ3Status Q3ViewAngleAspectCamera_SetFOV (
                     TQ3CameraObject camera,
                     float fov);
camera
An aspect ratio camera object.
fov
The desired maximum field of view, in radians, of the camera.

DESCRIPTION

The Q3ViewAngleAspectCamera_SetFOV function sets the maximum field of view of the camera specified by the camera parameter to the value specified in the fov parameter.

Q3ViewAngleAspectCamera_GetAspectRatio

You can use the Q3ViewAngleAspectCamera_GetAspectRatio function to get the aspect ratio of an aspect ratio camera.

TQ3Status Q3ViewAngleAspectCamera_GetAspectRatio (
                     TQ3CameraObject camera,
                     float *aspectRatioXToY);
camera
An aspect ratio camera object.
aspectRatioXToY
On exit, the horizontal-to-vertical aspect ratio of the specified camera.

DESCRIPTION

The Q3ViewAngleAspectCamera_GetAspectRatio function returns, in the aspectRatioXToY parameter, the horizontal-to-vertical aspect ratio of the aspect ratio camera specified by the camera parameter.

Q3ViewAngleAspectCamera_SetAspectRatio

You can use the Q3ViewAngleAspectCamera_SetAspectRatio function to set the aspect ratio of an aspect ratio camera.

TQ3Status Q3ViewAngleAspectCamera_SetAspectRatio (
                     TQ3CameraObject camera,
                     float aspectRatioXToY);
camera
An aspect ratio camera object.
aspectRatioXToY
The desired horizontal-to-vertical aspect ratio of the specified camera.

DESCRIPTION

The Q3ViewAngleAspectCamera_SetAspectRatio function sets the horizontal-to-vertical aspect ratio of the camera specified by the camera parameter to the value specified in the aspectRatioXToY parameter.


© 1997 Apple Computer, Inc.

Previous | QD3D Book | Overview | Chapter Contents | Next |